What’s New in the CygNet v9.6 Help

The v9.6 Online Help includes many documentation updates to describe the new features and enhancements contained in the CygNet Software v9.6 release.

Changes to the v9.6 Online Help

The following documentation items have been added, removed, or revised in the CygNet Software v9.6 Online Help. Changes are listed in order of the Online Help document sections in which they appear.

Alarms

• Documented the EACHistory.bin file (used to store any pending writes of any alarms that were impacted by Enhanced Alarm Configuration choices. The EACHistory.bin file is located in the service directory for each CVS)
• Documented the EAC_TO_ALARM_HISTORY keyword in the Enhanced Alarm Configuration (EAC) settings topic

• Added Troubleshooting Enhanced Alarm Configuration topic.

Auditing

• Added a new topic on Suppressing SetPoint Auditing Based User ID (updated in Patch-2022-05-12-SetpointAuditSuppression, released June 21, 2022).

Canvas

• See the What's New in the v9.6 Canvas Help section in the Canvas chapter for more information.

CygNet Bridge API

• Added a Connectivity Errors note to Troubleshooting CygNet Bridge.

CygNet Measurement — several new and updated features are documented in CygNet Measurement including the following areas:

• Added a Show only most recent records check box to the Raw Data control to load only the most recent record for each hour. Also added ShowMostRecentRecords property to the CygNet FMS Raw Data Control ActiveX control (in CygNet Studio) and the CxFmsRawDeviceDataCtrl scripting object.

• Updated the Validate Data command to allow selection of liquid device Nodes

• Added features, including an expand/collapse record viewing option and updated record state options in the Configuration control filter, to improve usability for handling "rejected" records in the Gas Analysis data view of the Configuration control

• Added tokens to the tables of supported data item tokens in the Liquid Device QTR Report Templates and the Liquid Device Raw QTR Report Templates topics to enable reporting of liquid configuration data

• Updated the tables of available FMS Validation Rules to include many newly implemented rules and types, including sets of rules to validate periodic metering and historical data for liquid device Nodes, to generate additional exceptions for liquid device Nodes

• Added the ability to view exceptions for liquid device Nodes in the Dashboard control, Exceptions control, and History Grid control

• The CygNet FMS Balance Control and CygNet FMS History Grid Control topics have been updated to describe additional functionality included in the "Required" FMS patches available in the 96_Patch_Composite.zip (updated October 28, 2022).

• The FMS Configuration File Keywords and Configuring Email Options and associated topics have been updated to describe added support for the OAuth 2.0 authentication protocol as an option when emailing FMS reports out of CygNet Measurement, as included in the "Required" FMS patches available in the 96_Patch_Composite.zip (updated October 28, 2022).

CygNet OPC Server

• Updated tag string formats in Omitting the Site.Service Specifier in the OPC Item for the CygNet OPC Server
• Added a new topic to describe Using External ID-based Tags in the OPC Item for the CygNet OPC Server
• Added a note about the most efficient way to register tags with the CygNet OPC Server (updated October 28, 2022)
• Other miscellaneous cleanup in the CygNet OPC Server section.

CygNet OPC HDA Server

• Updated tag string formats in Omitting the Site.Service Specifier in the OPC Item for the CygNet OPC HDA Server
• Added a new topic to describe Using External ID-based Tags in the OPC Item for the CygNet OPC HDA Server
• Added a note about the most efficient way to register tags with the CygNet OPC HDA Server (updated October 28, 2022)
• Other miscellaneous cleanup in the CygNet OPC HDA Server section.

CygNet OPC UA Server

• Added a new section to describe the new CygNet OPC UA Server.

CygNet Studio

• CAS View Control — added details on how to hide default menu items from display (updated in Patch-2022-04-08-CxHmiCas, released April 21, 2022)

• Configuring Context Menus and Custom Context Menu — updated images and related text (updated in Patch-2022-04-08-CxHmiCas, released April 21, 2022)

• Dynagraph Control — add new ActiveX properties to configure the background color of the Dynagraph object (BackColor) and the Dynagraph graph area (GraphBackgroundColor) (updated in Patch-2022-04-12-CxDynagraph, released April 21, 2022).

Devices — Communication Devices

• OPC Comm EIE — Documented Force synchronous I/O option and linked SyncIO on OPC EIE UIS Command Component Parameters, OPC Lufkin UIS Command Component Parameters, and OPC Weatherford UIS Command Component Parameters

• Clarified synchronous I/O, asynchronous I/O, and asynchronous callback support for the OPC Comm EIE.

Devices — Import/Export Devices

• Made several enhancements to the Text Import EIE section, supplemented the Filtering Data topic with better examples.

Devices — Remote Devices

• Amocams 700 — the following updates have been made to this EIE:
  • Added opcode 0x80 support for "Control Logs (Long)" (CtrlLogL), "Control Logs (Short)" (CtrlLogS), "Daily Prod Log" (DProdLog), "Monthly Prod Log" (MProdLog), "Prod Cycle Log" (ProdCLog), and "Test Set Prod Cycle Log" (TProdCLog) data groups
  • Added the 700EGMP2 and 700EGMWC to the list of supported device models
  • Noted "History – Hourly" (HrlyHist) data group support for Amo700EGMP2 and Amo700EGMWC devices that return a different response to the Upload Audit Log command. A new optional attribute, named autoDetectResponse, is available on the "History – Hourly" (HrlyHist) data group for the Amo700EGMP2 and Amo700EGMWC devices that return a different response to the Upload Audit Log command. If autoDetectResponse="true", the Amocams EIE will parse the data based on data length of the response. Response data will be parsed according to the Command Code 32 EGM layout as defined in the Communication Manuals for Models 700EGMWC and 700EGMP2 if the response data length matches.
• DNP3 EIE — Added information about events and event overflow, integrity polls, and automatic polling to the Polling Notes topic (previously titled Best Practices)
• DNP3 Emerson EIE — EFM support is now documented for the DNP3 Emerson EIE for Emerson FB3000 flow devices, which requires firmware version 02.07.02. The DNP3 Emerson driver has been modified to extrapolate EFM configuration, history, event, and alarm data needed by CygNet FMS. Added information about events and event overflow, integrity poll, and automatic polling to the Polling Notes topic.
• IoT Sparkplug EIE — the following updates have been made to this EIE:
  • Added a IoTSparkplug_POC.dtf example including the CardCnt dgElement, required when ForeSite collects card from the IoT device
  • Added a note about processing NDEATH and NBIRTH messages
  • Added a note about bdSeq matching
• Modbus Pickford EIE — A new EIE called the Modbus Pickford EIE has been released, which supports a DrSCADA TPG700 Wellhead Manager pump controller field device. The EIE contains all standard Modbus functionality plus additional special handling for dynacards.
• Clarified synchronous I/O, asynchronous I/O, and asynchronous callback support for the OPC EIEs
• OPC EIE — the following updates have been made to this EIE:
  • Added a new topic Using Sentinel Values to Indicate Unreliable Data about configuring point processing to handle unreliable values returned from an OPC server (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022)
  • Supplemented OPC Quality Mapping topic with new information about updating values for mapped quality bits
  • Updated OPC EIE Editor - Device Page with Sentinel Value options
  • Updated OPC EIE - Data Groups with Sentinel Value options
• OPC Lufkin EIE — the following updates have been made to this EIE:
  • Updated OPC Lufkin EIE Editor - Device Page with Sentinel Value options (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022)
  • Added OPC Lufkin EIE - Data Groups, linked to OPC EIE - Data Groups (for shared information for all OPC EIEs)
• OPC Weatherford EIE — the following updates have been made to this EIE:
  • Indicated support for OPC Baker 8300/8500 protocol devices on the Matrikon ScadaCAC OPC server and OPCWFord_8500.dtf to support Matrikon OPC card retrieval from Baker 8300/8500 protocol devices

  • Indicated support for version 2 of legacy (FC16) dynagraph card format used by ScadaCAC to get data from Baker 8500 devices. Previously only version 3 was supported.

  • Updated OPC Weatherford EIE Editor - Device Page with Sentinel Value options (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022)
  • Added OPC Weatherford EIE - Data Groups 
    • linked to OPC EIE - Data Groups (for shared information for all OPC EIEs)
    • added table of supported data groups
    • indicated that the OPC Weatherford EIE now supports composite data groups
    • the DynaConfig "Pumpoff Configuration" data group is required to render the POC stroke percentage
• Totalflow EIE — added K Factor Mass to FMS Configuration Data Group Mapping topic (updated in Patch-2022-05-03-TotalFlow, released May 24, 2022)
• Updated introduction to preCard and postCard device template file elements.

Filter Rules

• Added a note to clarify about filter rules in XML using the spelling "qualifer="

• Noted this spelling discrepancy in script examples.

General Notification Service

• Added documentation support for the OAuth 2.0 (Graph API) authentication protocol for email processing
• Added a topic on how to configure Azure Active Directory, Microsoft 365 server, and CygNet’s GnsConfig utility to work together to send and receive email messages using Graph API. See Configuring Microsoft 365 to work with Graph API.
• Updated documentation support for Email Messsage notification type
• Updated the Email page of the GNS Configuration Tester utility and the GNS configuration file (Gns.cfg) to reflect support for the OAuth 2.0 authorization mode
• Updated the documentation for the VoIP page of the GNS Configuration Tester utility to reflect usability changes to the page
• See added and modified keywords in the GNS configuration file (Gns.cfg) in the Services section below.

Points

• Added a long-form topic about how status bits, point status, point states, alarm conditions, alarm priority categories, and the point scheme work together to provide status information about a real-time record (RTR) in a Current Value Service (CVS)

• Documented unit aliases for PNT Engineering Units (updated October 28, 2022).

OPC

• Added information about using sentinel values in the OPC EIEs in the OPCIS vs OPC EIEs topic (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022).

OPCIS

• Clarified synchronous I/O, asynchronous I/O, and asynchronous callback support for the OPCIS.

Security — The following security event is now documented:

• SUPSPAUD — used to support the suppression of SetPoint audit records in the AUD service database based on user ID (updated in Patch-2022-05-12-SetpointAuditSuppression, released June 21, 2022).

Scripting

• Updated SetPointEx2 method documentation
• Updated CxHmiFms properties tables for FMS ActiveX controls
• CxDds.DdsClient
  • Updated code sample for GetDataGroupTransactionData method
  • Updated description for the GetDataGroupTxDataWithRefs method
  • Added code sample for the GetDataGroupTxDataWithRefs method

• CxDds.DdsClient — documented new methods to support adding, deleting, and modifying a data group transaction through the COMAPI interface . Identified multithreaded calls. Reformatted code examples (updated in limited patch April 22, 2022)
  • AddDataGroupTransaction
  • AddDataGroupTransactionByFile
  • AddDataGroupTransactionByID
  • DeleteDataGroupTransaction
  • DeleteDataGroupTransactionByDbKey
  • DeleteDataGroupTransactionByFile
  • UpdateDataGroupTransaction
  • UpdateDataGroupTransactionByFile

• CxFac.FacClient Methods — Identified multithreaded calls. Reformatted code examples (updated April 22, 2022)
• CxPnt.PntClient Methods — Identified multithreaded calls. Reformatted code examples (updated April 22, 2022)
• CxUis.UisClient Methods — Identified multithreaded calls. Reformatted code examples (updated April 22, 2022).

Service Monitoring Info Items — The following info items are now documented:

• LOGQUEUED_ELS — The number of entries on the log to the ELS queue
• LOGREJECTED_ELS — The number of entries on the log to the ELS queue that were rejected
• MACH_COMMIT_FREE — The maximum number of bytes that can still be committed without growing the page file (Analogous to Free RAM) (updated June 21, 2022)
• MACH_COMMIT_PEAK — The maximum number of bytes that have ever been committed (updated June 21, 2022)
• MACH_COMMIT_TOTAL — The maximum number of bytes that can be committed without growing the page file (Analogous to Total RAM) (updated June 21, 2022)
• SETPOINT_USERSEC_ENABLED — Indicates whether setpoint audit record creation in the AUD service database is suppressed based on user ID. Options are 0 (false) and 1 (true). Specifies the value of the AUDIT_SETPOINT_USERSEC_ENABLED service configuration keyword. See Suppressing SetPoint Auditing Based on User ID for more information about this feature (updated in Patch-2022-05-12-SetpointAuditSuppression, released June 21, 2022).
• UIS_DDS_CACHE_ERRS —The number of errors in the DDS data cache.

Services

• Fixed the hyperlinks on the Data Flow diagram
• Added the ACTIVE_DIRECTORY_TLS_USAGE keyword to ACS Configuration File Keywords (Acs.cfg)
• Added several new keywords to the FMS Configuration File Keywords topic to support OAUTH 2.0 email authorization mode:
  • EMAIL_AUTH_MODE
  • EMAIL_OAUTH_TYPE
  • EMAIL_OAUTH_AUTHORITY
  • EMAIL_OAUTH_TENANT
  • EMAIL_OAUTH_CLIENT_ID
  • EMAIL_OAUTH_CLIENT_SECRET
• Added several new keywords to the GNS Configuration File Keywords topic to support OAUTH 2.0 email authorization mode:
  • EMAIL_AUTH_MODE
  • EMAIL_CHECK_CERT_REVOKE_LISTS
  • EMAIL_OAUTH_AUTHORITY
  • EMAIL_OAUTH_CLIENT_ID
  • EMAIL_OAUTH_CLIENT_SECRET
  • EMAIL_OAUTH_TENANT
  • EMAIL_OAUTH_TYPE
  • GRAPH_RESPONSE_TIMEOUT
  • POP3_PASSWORD
  • POP3_USERNAME
  • SMTP_PASSWORD
  • SMTP_USERNAME
• Two existing keywords are now used by both the POP and GRAPH API servers, so they have been renamed and moved to the Shared Mail Settings section of the to the GNS Configuration File Keywords topic:
  • EMAIL_POLLING_RATE (previously POP3_UPDATE_RATE)
  • EMAIL_RETAIN_COUNT (previously POP3_EMAIL_RETAIN_COUNT).

Uniform Data Codes

• Moved the Uniform Data Codes section of topics out of the Tables chapter to the top level.

Other Updates

• Updated CygNet Training, Support, and Sales contact details.